Skip to content

docs: 修正文档末尾拉取请求错位链接 - #361

Open
ovo75u wants to merge 14 commits into
OpenHUTB:masterfrom
ovo75u:master
Open

ovo75u wants to merge 14 commits into
OpenHUTB:masterfrom
ovo75u:master

Conversation

@ovo75u

@ovo75u ovo75u commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

变更内容

这次主要清理和补充了几个文档与代码里的小问题,具体如下:

  1. 修正 Markdown 语法:重写了 reports_guide.md,换成了标准的语法,并补充了具体怎么用脚本生成报告的运行命令。
  2. 去除个人信息:把 README.md 里个人的计划删了。
  3. 清理冗余代码:把 src/git_commit_stats.py 里之前注释掉的、重复的 import 代码删了。
  4. 修正错位的链接:index文档末尾“提交拉取请求直接修改文档”这句话中,链接文字是“拉取请求”,但实际指向的却是 贡献指南文件。已将链接地址修改为真正的拉取请求页面地址(.../pulls)。

变更范围

  • 文档内容(markdown)
  • 配置 / 批处理 / 脚本
  • 其他:______

自查清单

  • 仅包含与本次变更相关的文件(无夹带修改)
  • 涉及链接 / 图片路径的目标均已确认存在
  • YAML / 脚本格式正确并已本地验证

Signed-off-by: ovo75u <1444654239@qq.com>
Signed-off-by: ovo75u <1444654239@qq.com>
Signed-off-by: ovo75u <1444654239@qq.com>
Signed-off-by: ovo75u <1444654239@qq.com>
Signed-off-by: ovo75u <1444654239@qq.com>
Signed-off-by: ovo75u <1444654239@qq.com>

@0516ywh 0516ywh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

翻了下,有个事实错误得先改:

reports/ 里的 CSV 不是 git_commit_stats.py 跑出来的。这目录现在是 OpenHUTB-2026-10-01T03-13-22Z-30-days.csv 这种名字,全部来自 .github/workflows/repo_metrics.yml 里的 nicklegan/github-org-repo-metrics-action(每月 1 号跑,文件名带时间戳)。git_commit_stats.py 是另一个手动统计工具,默认输出 commit_stats.csv,跟目录里这几份的命名完全不是一回事。所以「报告不用手动弄,跑 src 目录下的 git_commit_stats.py 脚本就自动生成了」这句会让读者以为报告是本地跑出来的。建议把两套东西分开写:reports/ 是 CI 每月生成的、缺了怎么补;脚本是手动统计某段时间的提交。

另外这个 PR 把三件不相干的事塞一起了:首页那个拉取请求链接、新增这份说明、还有脚本里删重复 import。仓库自查清单里写着「仅包含与本次变更相关的文件」,拆开提更好,不然后面 git blame 不好追。脚本那两行删得没毛病——顶层 from collections import Counter 还在,email_counts 也照常用,我本地跑 --help 是正常的。

最后,文件名 reports/reports_guide.md 有点尴尬:GitHub 点进 reports 目录只会自动渲染 README.md,这个文件得再点一层才看得到。改成 reports/README.md 更顺。

改完我再看。

@L269109

L269109 commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

对于第四个修改点:
我查看了原文上下文(docs/index.md),原文的句子是:“如果对文档中的任何问题可以在本文章的源仓库中的问题页面讨论或者提交拉取请求直接修改文档。”

修改前的原文档界面:

Image

仓库的贡献指南(CONTRIBUTING.md):
Image

意见:原作者将链接指向 CONTRIBUTING.md 并没有错,因为贡献指南中详细说明了提 PR 的规范。但结合这句话“提交拉取请求直接修改文档”的行动指引,作者将其改为 https://github.com/OpenHUTB/.github/pull/ 后,用户可以直接到达 PR 列表页面,一键发起新的 PR。

这是一个从“阅读说明”到“直接行动”的体验优化。修改后的链接更符合句子原本的号召意图。

整体看没有破坏原有功能,且提升了便利性。LGTM(Looks Good To Me),可以合并。

Signed-off-by: ovo75u <1444654239@qq.com>
补充了.github/workflows/repo_metrics.yml以及action全称,和评审意见保持一致

Signed-off-by: ovo75u <1444654239@qq.com>
@ovo75u
ovo75u requested a review from 0516ywh November 7, 2026 13:47
@ovo75u

ovo75u commented Nov 7, 2026

Copy link
Copy Markdown
Contributor Author

@0516ywh 感谢细致的Review!
本次已完成修改:

  1. 更新reports/README.md,区分CI自动生成CSV报告与git_commit_stats.py本地手动统计脚本,并且补充了工作流路径、action全称,和评审意见保持一致
  2. 文件已经是reports/README.md
    关于PR混杂了多件改动,本次先保留,后续有机会再拆分PR。
    麻烦帮忙再审阅一下,谢谢!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants